home *** CD-ROM | disk | FTP | other *** search
/ QRZ! Ham Radio 8 / QRZ Ham Radio Callsign Database - Volume 8.iso / mac / files / f6fbb / carbon_3.exe / CARBON3.DOC < prev    next >
Text File  |  1992-12-28  |  16KB  |  327 lines
  1.  
  2.  
  3.  
  4.                           CARBON SERVER PROGRAM (VERSION 3)
  5.                           =================================
  6.         
  7.                                     FOR F6FBB BBS
  8.                                     =============
  9.         
  10.                               WRITTEN BY KEN WOOD G3WCS
  11.                               =========================
  12.         
  13.         IMPORTANT
  14.         =========
  15.         This  software is released into the Public Domain and is designed  for 
  16.         use  by radio amateurs running BBS systems.  It may not be sold  under 
  17.         any  circumstances.   It  may  be passed freely  from  one  person  to 
  18.         another, provided there is no charge, either financial or otherwise.
  19.         
  20.         The  only condition regarding the passing on of this software is  that 
  21.         the  original  documentation  is included.  I  make  this  stipulation 
  22.         because  problems arising with previous releases have inevitably  been 
  23.         due  to  people  attempting to run the software  without  the  correct 
  24.         documentation.  To this end, you must distribute the archived file  as 
  25.         supplied originally.
  26.         
  27.         
  28.         OVERVIEW
  29.         ========
  30.         This  server  has  the ability to duplicate any  number  of  identical 
  31.         messages  after  reception  of one uniquely  addressed  message  to  a 
  32.         certain  server callsign.  According to the way that the  distribution 
  33.         file  is  set  up, the SYSOP has the option to  allow  only  specified 
  34.         callsigns,  or  alternatively any callsign, to send  messages  to  the 
  35.         server   for  duplication.   In addition,  the  carboned  message  may 
  36.         optionally  include  a list of the callsigns to whom the  message  has 
  37.         been  dispatched.   This version was written taking into  account  the 
  38.         wishes  of  various  users.  I hope that the  server  is  sufficiently 
  39.         flexible to cater for all needs.
  40.         
  41.         Here is a summary of the features included in this version.
  42.         
  43.         1.   The server runs immediately on reception of the incoming message.  
  44.         I have included this facility to increase expedition and  because  the 
  45.         configuration options are comprehensive enough to prevent most abuse.
  46.         
  47.         2.   The  acknowledgement message sent to the sender of  the  incoming 
  48.         message is now more accurately addressed.
  49.         
  50.         3.   The outgoing messages show the "from" callsign as that of the BBS 
  51.         at  which  the server operation took place, not the user,  as  before. 
  52.         This is to prevent incorrect White Page operation which will otherwise 
  53.         attribute  an  incorrect home BBS to a user whose CARBON  message  has 
  54.         been  daisy  chained from one CARBON server to  another.  The  senders 
  55.         callsign is embedded in the actual message and will be correctly  read 
  56.         by any subsequent CARBON process.
  57.         
  58.         4.   A  wildcard  entry is allowed in the distribution  file,  meaning 
  59.         that  any  station  may send a message  to  the  server.   Previously, 
  60.         stations inputting messages had to be on an authorised list.  The list 
  61.         facility is still retained and the SYSOP may decide which to use.   If 
  62.         several  server callsigns are in use at the BBS, each server  callsign 
  63.         now has the option of wildcard entry or authorised list.  You may  mix 
  64.         at will.
  65.         
  66.         5.   Each  carboned  message  may or may not include  a  list  of  the 
  67.         stations  who will receive the message.  Once again the SYSOP has  the 
  68.         option  to  enable  or  disable this facility on  any  of  the  server 
  69.         callsigns he has installed.
  70.         
  71.         6.   There is now no limit to the minimum size of message sent to  the 
  72.         server.   Previously,  messages had to contain at least two  lines  of 
  73.         text to be correctly duplicated.
  74.           
  75.         7.   There  is no limit to the number of callsigns on  a  distribution 
  76.         list.   Thus  for  large distributions there is no need  to  have  one 
  77.         server message calling another at the same BBS.
  78.         
  79.         8.   Hierarchical   addresses   are  now  permitted  in   the   server 
  80.         distribution list.
  81.         
  82.         9.   When an incoming message is received from another CARBON3 server, 
  83.         the server name and distribution list information are not  duplicated.  
  84.         This reduces the message size and removes redundant information.
  85.         
  86.         10.  In  the  event  that  the server is unable to  find  one  of  the 
  87.         required  disk  files,  a  message will be  generated  for  the  SysOp 
  88.         advising the problem.
  89.         
  90.         
  91.         OPERATION
  92.         =========
  93.         Upon  receipt  of a correctly addressed input message, the  F6FBB  BBS 
  94.         software   automatically  exports  it  to  a  temporary   disk   file. 
  95.         Immediately  after this the CARBON server is executed.  The  temporary 
  96.         message  is  read,  as is the  distribution  file  called  CARBON.DIS. 
  97.         Depending  upon  the  configuration  of  CARBON.DIS,  the  message  is 
  98.         duplicated  to several callsigns.  In addition, a message for the  BBS 
  99.         SYSOP  is generated informing him of the server activity.   A  further 
  100.         message  for the originator of the message is created advising him  of 
  101.         successful  distribution.   He is not sent a copy  of  the  duplicated 
  102.         message. In the event that an unauthorised attempt is made to use  the 
  103.         server, the SYSOP will receive an informative message.  The sender  of 
  104.         the  unauthorised message will not receive an  acknowledgement.  After 
  105.         completion   of   these  procedures  the  temporary   disk   file   is 
  106.         automatically deleted.
  107.         
  108.         
  109.         COMPATIBILITY WITH PREVIOUS VERSIONS
  110.         ====================================
  111.         This version is a complete rewrite of the source code.  Messages which 
  112.         have  been  processed by an earlier version and sent  to  CARBON3  for 
  113.         daisy  chaining  will  still  work.   However,  the  previous   server 
  114.         information  and any distribution list will not be removed.  For  this 
  115.         reason  it  is advisable for your neighbours to upgrade  to  this  new 
  116.         version as well.
  117.         
  118.         
  119.         SETTING UP
  120.         ==========
  121.         Please pay careful attention to the following set up procedure.   Most 
  122.         problems  occur because a mistake or omission has been made in one  or 
  123.         other  of  the  files.   Please check all  these  before  reporting  a 
  124.         problem.
  125.         
  126.         When modifying or creating files remember to use an ASCII text editor. 
  127.         A word processor, such as Wordstar [tm] (in document mode), which  may 
  128.         embed hidden control codes is NOT suitable.
  129.         
  130.         
  131.         REMOVAL OF OLD CARBON SERVER (VERSION ONE)
  132.         ------------------------------------------
  133.         This  section  only  applies if you are presently  using  my  original 
  134.         CARBON1  server.   If  you are not, please skip forward  to  the  next 
  135.         section.
  136.         
  137.         1.   Delete the existing CARBON.EXE from the FBB or BIN directory.
  138.         
  139.         2.   Delete the following line (or your equivalent) from CRON.SYS,  in 
  140.         the FICHIERS or SYSTEM directory :-
  141.         
  142.         0-23 C:\FBB\CARBON.EXE C:\FBB\   or   X C:\FBB\CARBON.EXE C:\FBB\.
  143.         
  144.         Leave the lines relating to any other servers intact.
  145.         
  146.         3.   In  the file BBS.SYS in the FICHIERS or SYSTEM directory,  remove 
  147.         the line which mentions the CARBON servers.  This will look  something 
  148.         like :-
  149.         
  150.         61 CARBON
  151.         
  152.         Remember  to leave the "61" present, just delete the  CARBON  letters.  
  153.         Be  sure  not  to delete the lines relating to  other  BBS  or  export 
  154.         entries.
  155.         
  156.         4.   In  the file FORWARD.SYS delete the lines relating to the  CARBON 
  157.         server forwarding.  These will look something like :-
  158.         
  159.         A CARBON
  160.         P @
  161.         C C:\FBB\CARBON.OUT
  162.         B CARBON
  163.         F CC1LOC
  164.         F CC1CLU
  165.         ------
  166.         Be sure to leave the lines relating to the other servers intact.
  167.         
  168.         5.   Modify the file CARBON.DIS to comply with the syntax in the  next 
  169.         section on INSTALLATION.
  170.         
  171.         REMOVAL OF OLD CARBON SERVER (VERSION TWO)
  172.         ------------------------------------------
  173.         The  upgrade from CARBON2 to CARBON3 is simply a matter  of  replacing 
  174.         the  program  file CARBON.EXE with the new version.  Please  note  the 
  175.         previous  remarks  about  receiving  carboned  messages  from  earlier 
  176.         versions for subsequent daisy chaining.
  177.         
  178.         INSTALLATION
  179.         ------------
  180.         1.   Copy  the  program CARBON.EXE from the distribution  disk  (after 
  181.         unarchiving) to your FBB or BIN directory.
  182.         
  183.         2.   Edit  the file INIT.SRV in the FBB directory.  At the end of  the 
  184.         file  are several lines specifying which servers you  have  installed.  
  185.         You  must make a separate entry for each server callsign you  wish  to 
  186.         use.  For example, assume that you will run three server addresses:-
  187.         
  188.         CC1COM  for all committee members, FBB99 for distribution of  messages 
  189.         about F6FBB software and CC1CLU for messages to local club members.
  190.         
  191.         The lines in INIT.SRV would be something like :-
  192.         
  193.         #
  194.         #
  195.         --------
  196.         # List of the services.  There is no limit to the number of
  197.         # services.  The list should end with a series of dashes.
  198.         #
  199.         CC1COM CARBON.EXE Committee Members Server
  200.         FBB99  CARBON.EXE FBB News Distribution Server
  201.         CC1CLU CARBON.EXE Local Radio Club Members News
  202.         #
  203.         --------
  204.         #
  205.         # End of initialisation file.
  206.         #
  207.         
  208.         Obviously  the plain language description for each callsign is  up  to 
  209.         you  and  will be shown to users when they use the PS command  on  the 
  210.         BBS.
  211.         
  212.         3.   Create  (or modify) a file called CARBON.DIS which MUST exist  in 
  213.         the  FBB directory.  The best way to explain this file is to  show  an 
  214.         example  with  comments.   An example follows.   DO  NOT  include  the 
  215.         comments,  such as  "<=====  Server callsign" in your file,  they  are 
  216.         for explanation only.  Use only the left hand side of the listing.
  217.         
  218.              [CC1COM]               <===== Server Callsign.
  219.         G3WCS                       <===== These callsigns are
  220.         G3ZZJ                       <===== permitted to send input
  221.         G4OAR                       <===== messages to the CC1COM
  222.         G4WSD                       <===== server callsign.
  223.              (DISTRIBUTION)         
  224.         LIST                        <===== Msgs will have distribution list.
  225.         G6FCI @ GB7FCI              <===== These callsigns will
  226.         G3ZZJ @ GB7CHS              <===== receive the carboned 
  227.         G4OAR @ GB7OAR              <===== message.
  228.         G4WSD @ GB7CRG
  229.         G4PGO @ GB7LIV
  230.              [FBB99]                <===== Server Callsign.
  231.         *.*                         <===== Anybody may send message to server.
  232.              (DISTRIBUTION)
  233.         LIST                        <===== Msgs will have distribution list. 
  234.         G6FCI @ GB7FCI              <===== These callsigns will 
  235.         G0NGL @ GB7NWP              <===== receive the carboned
  236.         G4OAR @ GB7OAR              <===== message.
  237.         G3WCS @ GB7CHS
  238.              [CC1CLU]               <===== Server Callsign.
  239.         *.*                         <===== Anybody may send message to server.
  240.              (DISTRIBUTION)
  241.         NOLIST                      <===== No distribution list in messages.
  242.         G3WCS @ GB7CHS              <===== These callsigns will
  243.         G3ZZJ @ GB7CHS              <===== receive the carboned
  244.         G4OAR @ GB7OAR              <===== message.
  245.         G4WSD @ GB7CRG
  246.         G0NGL @ GB7NWP
  247.         G8AEN @ GB7BEV
  248.         
  249.         The  example clearly shows the syntax for the various  formats.   LIST 
  250.         indicates  that  each  carboned message contains a  list  of  all  the 
  251.         callsigns  who  have  been sent the message.   NOLIST  indicates  that 
  252.         messages  will not include this list.  This has been  incorporated  to 
  253.         reduce message size where a SYSOP has a large distribution list and to 
  254.         reduce network congestion.
  255.         
  256.         There  are a couple of important points here.  There must be no  blank 
  257.         lines  in the file.  Note the difference in the brackets used for  the 
  258.         carbon  callsign designator compared with the distribution list.   You 
  259.         may  place  hierarchical routings after the "@" symbol  (eg.  DK2LK  @ 
  260.         DB1JH.DEU.EU).  The indentation of the bracketed text is not  required 
  261.         but  may  be  used  to distinguish between  blocks.   This  is  normal 
  262.         programming technique.
  263.         
  264.         
  265.         APPENDED TEXT
  266.         =============
  267.         You may enter a message to the server from the BBS keyboard and append 
  268.         text  from  another text file, (eg. SP FBB99 +  C:\TEXT.DOC).   Please 
  269.         ensure  that  your appended text file does not  contain  any  embedded 
  270.         control  codes  or other non printable characters.  See  the  previous 
  271.         notes on this subject. 
  272.         
  273.         
  274.         MEMORY REQUIREMENTS
  275.         ===================
  276.         When FBB BBS is loaded and running, the status line will show how much 
  277.         free  memory is available.  This is indicated on the right  hand  side 
  278.         and an example might be :- Ok:122040.
  279.         
  280.         The  number  of  free bytes is governed by various  factors,  such  as 
  281.         whether  you  are running EMS or XMS, and what items you  have  loaded 
  282.         into  high memory.  When any server, be it CARBON or another  program, 
  283.         is executed some of that free memory is used.  After completion of the 
  284.         server  operation the memory is returned to the system for other  use.  
  285.         It is advisable to arrange your system configuration to leave at least 
  286.         100  Kbytes  showing  free on the status line.  CARBON  is  a  compact 
  287.         program  and does not require a great deal of memory in which to  run.  
  288.         This  is  due to the fact that all information required is  read  from 
  289.         disk  at  run time and not stored in memory.  This is the  reason  why 
  290.         there is no restriction to the number of callsigns in the distribution 
  291.         list.  Some servers require much more free memory, hence the advice to 
  292.         leave  about  100  Kbytes free.  Obviously, with  an  extremely  small 
  293.         amount of free memory, even CARBON will not function correctly.
  294.         
  295.         
  296.         ERROR REPORTS
  297.         =============
  298.         If  the  server is unable to find one of the required disk  files,  it 
  299.         will  in most cases, generate a message to the BBS SysOp advising  why 
  300.         the operation has failed.  This report will be appended to MAIL.IN and 
  301.         appear as a normal system message.
  302.         
  303.         
  304.         FINALLY
  305.         =======
  306.         A  user  document is included with the distribution.   The  SYSOP  may 
  307.         place this in the "files" area so that users may see the input message 
  308.         syntax, without reading the full SYSOP instructions.
  309.         
  310.         The  server has been extensively tested but the old adage,  "There  is 
  311.         always one more bug", must prevail.
  312.         
  313.         Please  report any problems or indeed any suggestions for  improvement 
  314.         to me by packet radio.
  315.         
  316.         Ken Wood.  G3WCS.
  317.         SYSOP GB7CHS.#11.GBR.EU
  318.         Cheshire NTS Mailbox.
  319.         
  320.         28/12/92.
  321.         
  322.         Ver 3.10
  323.         
  324.         
  325.         CARBON3.DOC
  326.  
  327.